fix: correctly type callback indices as an array#12393
Merged
Merged
Conversation
The `Binary` and `Ternary` callback types declared the third argument as
`index: number`, but the implementations invoke the callback with an
array of dimension indices (e.g. `[ i, j ]` for `map2d`, `[ i, j, k ]`
for `map3d`, etc.), and the accompanying TSDoc already documents the
argument as `indices`. Retype the argument as `indices: Array<number>`
in the `Binary` and `Ternary` callback signatures of `map2d`, `map3d`,
`map4d`, and `map5d`, and add declaration tests exercising a callback
that consumes the indices array.
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown_pkg_readmes
status: na
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: na
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
May 31, 2026
kgryte
changed the title
map2d/map3d/map4d/map5d callback indices as an array
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request fixes the callback type signatures of
map2d,map3d,map4d, andmap5d. TheBinaryandTernarycallback types declared the third argument asindex: number, but the implementations invoke the callback with an array of dimension indices (e.g.fcn.call( thisArg, a[ j ], [ i, j ], arr )inmap2d), and the accompanying TSDoc already documents the argument asindices. Specifically, it:index: numbertoindices: Array<number>in theBinaryandTernarycallback signatures of all four packages, matching both the runtime and the existing@param indicesdocumentation.indicesarray (the previous tests only used a unary callback, so they did not cover this argument).All four declaration files and their type tests pass the
lint-typescript-declarations-files(expect-type) checks.One of several follow-up PRs from a
@stdlib/utilsdeclaration audit. Opened as a draft for review of the public callback-type change.Related Issues
No.
Questions
No.
Other
Verified against the implementations: each
map<n>dpasses ann-element index array to the callback. Surfaced by a multi-agent audit of the@stdlib/utilsdeclarations.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored primarily by Claude Code, which confirmed the callback argument against each implementation, retyped the signatures, added exercising tests, and verified them with the
expect-typedeclaration tests.@stdlib-js/reviewers